From: Colin Walters Date: Sat, 14 Jun 2025 05:28:22 +0000 (+0200) Subject: rust: Tweaks for README.md X-Git-Tag: archive/raspbian/2025.7-2+rpi1^2^2~6^2~4^2~20^2 X-Git-Url: https://dgit.raspbian.org/%22http:/www.example.com/cgi/%22https://%22%22/%22http:/www.example.com/cgi/%22https:/%22%22?a=commitdiff_plain;h=dc97aa2acaeaf164483e1cedde7601ef148c0301;p=ostree.git rust: Tweaks for README.md Mostly an excuse to publish a new crate to test that regenerating the docs works. --- diff --git a/rust-bindings/README.md b/rust-bindings/README.md index 7642a76d..2dba76cf 100644 --- a/rust-bindings/README.md +++ b/rust-bindings/README.md @@ -1,18 +1,17 @@ # ostree-rs -[![pipeline status](https://gitlab.com/fkrull/ostree-rs/badges/main/pipeline.svg)](https://gitlab.com/fkrull/ostree-rs/commits/main) [![Crates.io](https://img.shields.io/crates/v/ostree.svg)](https://crates.io/crates/ostree) -[![main-docs](https://img.shields.io/badge/docs-main-brightgreen.svg)](https://fkrull.gitlab.io/ostree-rs/ostree) +[![main-docs](https://img.shields.io/badge/docs-main-brightgreen.svg)](https://docs.rs/ostree) **Rust** bindings for [libostree](https://ostreedev.github.io/ostree/introduction/). -libostree is both a shared library and suite of command line tools that combines +libostree is both a shared library and a suite of command line tools that combines a "git-like" model for committing and downloading bootable filesystem trees, along with a layer for deploying them and managing the bootloader configuration. > **Note**: this crate was renamed from the `libostree` crate. ## Status -Most bindings that can be auto-generated are being auto-generated by now. +Most bindings that can be auto-generated are being auto-generated. Anything that is not yet supported by the crate probably requires handwritten bindings. These will most likely be added on an as-needed basis. @@ -36,7 +35,7 @@ To use the crate, add it to your `Cargo.toml`: ```toml [dependencies] -ostree = "0.10" +ostree = "0.20" ``` To use features from later libostree versions, you need to specify the release @@ -44,8 +43,8 @@ version as well: ```toml [dependencies.ostree] -version = "0.10" -features = ["v2021_1"] +version = "0.20" +features = ["v2025_2"] ``` ## Developing @@ -54,7 +53,7 @@ Cargo commands. ### Generated code Most code is generated based on the gir files using the -[gir](https://github.com/gtk-rs/gir) tool. +[gir](https://github.com/gtk-rs/gir) tool. You can update `OSTree-1.0.gir` by directly copying it from a local ostree build.